fix(docs): align relay systemd install flags with actual CLI#6984
fix(docs): align relay systemd install flags with actual CLI#6984Abdul-Moiz31 wants to merge 3 commits into
Conversation
infisical relay systemd install does not support --enroll-method or --relay-id (confirmed against its --help output in Infisical#6979) — those flags only exist on relay start. The systemd install examples were copied from relay start and silently failed with "unknown flag: --enroll-method". Updates the examples to use the install subcommand's actual flags (--token / --type=instance --relay-auth-secret) and documents its full flag set. Fixes Infisical#6979
|
| Filename | Overview |
|---|---|
| docs/cli/commands/relay.mdx | Fixes wrong flags in systemd install examples (removed --enroll-method/--relay-id, added --type=instance/--relay-auth-secret), adds explanatory notes and a full flag list for the install subcommand; minor terminology inconsistency between the --token description and the Token Auth example placeholder. |
Reviews (1): Last reviewed commit: "fix(docs): align relay systemd install f..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 51faacf7df
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
…ss token The install example reused relay start's <enrollment-token> placeholder for --token, but install's --token is a machine identity access token per its own --help text, not the one-time enrollment token relay start uses.
relaySystemdInstallCmd requires --host (it doesn't store/look it up server-side like relay start does) — add it to both install examples. Also drop the --type=instance/--relay-auth-secret mapping for AWS-auth relays: that's a separate static-secret instance mechanism and isn't equivalent to relay start --enroll-method=aws --relay-id. There's no systemd install path for AWS-authenticated relays today.
|
hi @varonix0 can you please review it Thankyou. ! |
1 participant
Context
`infisical relay systemd install` doesn't support `--enroll-method` or `--relay-id` — confirmed against its actual `--help` output (see #6979). Those flags only exist on `infisical relay start`. The systemd install examples in the docs were copied from the `start` command and fail with `unknown flag: --enroll-method`.
Fixes #6979
Changes
Steps to verify the change
Type
Checklist